hep.analysis
Class EventGenerator

java.lang.Object
  |
  +--hep.analysis.EventHandler
        |
        +--hep.analysis.EventGenerator

All Implemented Interfaces:

EventSource

Direct Known Subclasses:

DiagnosticEventGenerator

public abstract class EventGenerator

extends EventHandler

implements EventSource

Fields inherited from class hep.analysis.EventHandler

out

Constructor Summary

EventGenerator()

Method Summary

void	close() Override to do cleanup when generator is no longer used
abstract EventData	generateEvent() Return an instance of EventData that offers access to all of the relevant fields for one event.
java.lang.Class	getEventDataClass() override to specify class of objects returned by generate event
java.lang.String	getName() override to specify name of event generator
EventData	getNextEvent() Returns generateEvent().
int	getTotalNumberOfEvents() Override if the number of events is known, and return that number.
java.lang.String	toString()

Methods inherited from class hep.analysis.EventHandler

afterLastEvent, beforeFirstEvent, histogram, histogram, sendMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface hep.analysis.EventSource

afterLastEvent, beforeFirstEvent

Constructor Detail

EventGenerator

public EventGenerator()

Method Detail

generateEvent

public abstract EventData generateEvent()
                                 throws EndOfDataException

Return an instance of EventData that offers access to all of the relevant fields for one event.

Throws:

EndOfDataException - when there are no more events available

getTotalNumberOfEvents

public int getTotalNumberOfEvents()

Override if the number of events is known, and return that number.

Specified by:

getTotalNumberOfEvents in interface EventSource

getNextEvent

public final EventData getNextEvent()
                             throws EndOfDataException

Returns generateEvent(). This is a method from the EventSource interface.

Specified by:

getNextEvent in interface EventSource

Throws:

EndOfDataException - when there are no more events available

See Also:

EventSource

close

public void close()

Override to do cleanup when generator is no longer used

Specified by:

close in interface EventSource

getName

public java.lang.String getName()

override to specify name of event generator

Specified by:

getName in interface EventSource

getEventDataClass

public java.lang.Class getEventDataClass()

override to specify class of objects returned by generate event

Specified by:

getEventDataClass in interface EventSource

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object